Range

Function

This API is used to get parameter range for Record > Record Tag page.

Note:

The Range provides reference information for client UI input limits and API request limits. When sending Get and Set requests, the parameters must be strictly limited according to the Range, otherwise the request may be rejected by the device.

Request Message

None.

Sample:

POST API/Playback/Tag/Range HTTP/1.1

{
    "version": "1.0",
    "data": {}
}

Response Message

Parameter Description

Table 1 (Search Request JSON)

ParameterRangeTypeDescription
channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…” WIFI_CH1x”
The number of channels depends on the capabilities of the device.		string arrayEach array bit represents a channel with a string.
start_datestringSearch startdate.
The date format is MM/DD/YYYY
end_datestringSearch end date.
The date format is MM/DD/YYYY
start_timestringSearch start time.
The time format is hh:mm:ss
end_timestringSearch start time.
The time format is hh:mm:ss
Keyword0-39stringWhen you search for tags, you only search for tags that contain keywords

Table 2 (Response Information JSON)

ParameterRangeTypeDescription
Pre-playstringStart playing the video with the label time forward ("5s")("10s")("30s")("1Min")("2Min")("5Min")("10Min").
Post-playstringPlay the recording at the end of the tag time ("5s")("10s")("30s")("1Min")("2Min")("5Min")("10Min").
all_tag_infojsonshow as follow Table 3
all_tag_num0-5000intHow many matching tags are found.

Table 3 (all_tag_info Information JSON)

ParameterRangeTypeDescription
Tag_datestringThe date format is MM/DD/YYYY.
Tag_timestringThe time format is hh:mm:ss.
channelstringThe channel to which the label belongs.
chNumintChannel number
label_idintTag ID
record_idintRecord ID
Tag_name0-39stringTag name

Table 4 (Add Tag Information JSON)

ParameterRangeTypeDescription
Tag_datestringThe date format is MM/DD/YYYY.
Tag_timestringThe time format is hh:mm:ss.
channelstring arrayThe channel to which the label belongs.
chNumintChannel number
label_idintTag ID
record_idintRecord ID
Tag_name0-39stringTag name
operate0-2int0- Set, 1- Delete, 2- Change the name

Tips:

The response message of the Range request may not contain all the fields in the above table, and the fields not included indicate that the device does not support this parameter configuration.

Sample:

HTTP/1.1 200 OK
Content-Type: application/json

{
	"version": "1.0",
	"result": "success",
	"data": {
		"start_date": {
			"description": "The date format is MM/DD/YYYY",
			"type": "string",
			"len": 10
		},
		"end_date": {
			"description": "The date format is MM/DD/YYYY",
			"type": "string",
			"len": 10
		},
		"start_time": {
			"description": "The time format is hh:mm:ss",
			"type": "string",
			"len": 8
		},
		"end_time": {
			"description": "The time format is hh:mm:ss",
			"type": "string",
			"len": 8
		},
		"Keyword": {
			"type": "string",
			"min_len": 0,
			"max_len": 20
		},
		"all_tag_num": {
			"type": "int32",
			"min": 0,
			"max": 5000
		},
		"all_tag_info": {
			"type": "array",
			"min_size": 0,
			"max_size": 5000,
			"items": []
		},
		"Pre-play": {
			"type": "string",
			"items": [
				"5s",
				"10s",
				"30s",
				"1Min",
				"2Min",
				"5Min",
				"10Min"
			]
		},
		"Post-play": {
			"type": "string",
			"items": [
				"5s",
				"10s",
				"30s",
				"1Min",
				"2Min",
				"5Min",
				"10Min"
			]
		},
		"date": "06/29/2023",
		"time": "13:19:40",
		"Tag_name": {
			"default": "Tag",
			"type": "string",
			"mode": "rw",
			"min_len": 1,
			"max_len": 39
		},
		"tag": {
			"type": "object",
			"items": {
				"channel": {
					"type": "string",
					"items": [
						"CH1",
						"CH2",
						"CH3",
						"CH4",
						"CH5",
						"CH6",
						"CH7",
						"CH8",
						"CH9",
						"CH10",
						"CH11",
						"CH12",
						"CH13",
						"CH14",
						"CH15",
						"CH16"
					]
				}
			}
		}
	}
}

Error Code

See Response Messages Body and Common error_code for more information.